chore(deps): update dependency docusaurus-plugin-llms to ^0.4.0#2500
chore(deps): update dependency docusaurus-plugin-llms to ^0.4.0#2500
Conversation
There was a problem hiding this comment.
Dependency Update: docusaurus-plugin-llms ^0.3.1 → ^0.4.0
This is a straightforward Renovate-managed dependency bump, and the lockfile update looks correct. However, there's a breaking change in v0.4.0 that warrants attention before merging.
Breaking Change: addMdExtension now defaults to true
From the release notes:
addMdExtensiondefaults totrue. All link URLs in generatedllms.txtfiles will now have.mdappended. To preserve the previous behavior, setaddMdExtension: falsein your plugin config.
The current plugin configuration in docs/docusaurus.config.ts does not set addMdExtension, so this upgrade will silently change the behavior of the generated llms.txt file:
// docs/docusaurus.config.ts (lines 10-19)
plugins: [
[
'docusaurus-plugin-llms',
{
generateLLMsTxt: true,
generateLLMsFullTxt: true,
title: 'Modular Pipelines Documentation',
description: '...',
// addMdExtension is NOT set — will now default to true
},
],
],After this update, links in llms.txt will change from:
https://thomhurst.github.io/ModularPipelines/docs/intro/
to:
https://thomhurst.github.io/ModularPipelines/docs/intro.md
GitHub Pages does not serve .md files, so those links would return 404s when followed by LLM crawlers.
Recommendation
Explicitly opt out of the new behavior to preserve the working link format:
plugins: [
[
'docusaurus-plugin-llms',
{
generateLLMsTxt: true,
generateLLMsFullTxt: true,
addMdExtension: false, // preserve pre-0.4.0 behavior; .md URLs 404 on GitHub Pages
title: 'Modular Pipelines Documentation',
description: '...',
},
],
],Alternatively, if the new .md-appended links are intentional (e.g., GitHub Pages is configured to handle them), adding addMdExtension: true explicitly makes the intent clear. Either way, the option should be set explicitly so future readers understand this was a conscious decision, not an oversight.
Up to standards ✅🟢 Issues
|
This PR contains the following updates:
^0.3.1→^0.4.0Release Notes
rachfop/docusaurus-plugin-llms (docusaurus-plugin-llms)
v0.4.0Compare Source
What's New
.mdto llms.txt link URLs — Per the llmstxt.org spec, links inllms.txtnow point to markdown versions of pages (e.g./docs/intro.mdinstead of/docs/intro/). (#38).mdxfiles starting withimportorexportstatements no longer use those lines as page descriptions. (#39)Breaking Change
addMdExtensiondefaults totrue. All link URLs in generatedllms.txtfiles will now have.mdappended. To preserve the previous behavior, setaddMdExtension: falsein your plugin config.Full Changelog: rachfop/docusaurus-plugin-llms@v0.3.1...v0.4.0
Configuration
📅 Schedule: (UTC)
🚦 Automerge: Enabled.
♻ Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by Renovate Bot.